feat(#3037): add API node.buffer.delete, node.buffer.wipe #3040

GCrispino · 2024-12-30T20:45:23Z

This PR adds two API methods for respectively deleting and wiping the buffer for the current file under the tree cursor:

Api.node.buffer.delete; and
Api.node.buffer.wipe,

fixes #3037.

They both use the same underlying function defined in the new file added at lua/actions/node/utils.lua.
This function checks if there's an opened and loaded buffer for the file under the tree cursor.
If there isn't, it notifies an error message.

Otherwise, it deletes/wipes the buffer if it's not modified (unless opts.force is true)

~~I'm setting this as WIP because I haven't run the make commands yet.~~
EDIT: done

alex-courtis

This works nicely, I look forward to using it.

Revert ApiTreeToggleOpts change
Change warning level of no-loaded-buffer
Remove unused options delete_buffer and wipe_buffer
Refactor action methods, message to follow
Add help at 6.3 API NODE nvim-tree-api.node

alex-courtis · 2025-01-13T03:24:36Z

lua/nvim-tree/api.lua

@@ -131,7 +132,7 @@ end
 Api.tree.open = wrap(actions.tree.open.fn)
 Api.tree.focus = Api.tree.open

---@class ApiTreeToggleOpts
+---@class ApiTreeToggleOptsApiTreeTo


What's the reason for this change? lua/nvim-tree/actions/tree/toggle.lua is still using this class...

No idea 😅 , this was probably done accidentally. Just reverted it 👍🏼

alex-courtis · 2025-01-13T03:25:37Z

lua/nvim-tree/api.lua

@@ -286,6 +287,16 @@ Api.node.navigate.diagnostics.prev_recursive = wrap_node(actions.moves.item.fn({
 Api.node.navigate.opened.next = wrap_node(actions.moves.item.fn({ where = "next", what = "opened" }))
 Api.node.navigate.opened.prev = wrap_node(actions.moves.item.fn({ where = "prev", what = "opened" }))

+---@class ApiNodeDeleteWipeBufferOpts
+---@field force boolean|nil default false


alex-courtis · 2025-01-13T03:26:40Z

lua/nvim-tree.lua

@@ -470,6 +470,8 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
    remove_file = {
      close_window = true,
    },
+    delete_buffer = {},
+    wipe_buffer = {},


Are these options used?

No, I was unsure if it was a convention to have these even if there are no underlying options, so I added these in even though they are empty.

I can remove them 👍🏼

alex-courtis · 2025-01-13T03:36:50Z

lua/nvim-tree/actions/node/utils.lua

Tested permutations and combination with :ls! reporting as expected.

vim.keymap.set("n", "BW", function() api.node.buffer.wipe(api.tree.get_node_under_cursor(), { force = false }) end, opts("Wipe")) vim.keymap.set("n", "BD", function() api.node.buffer.wipe(api.tree.get_node_under_cursor(), { force = true }) end, opts("Delete"))

Great! Thank you 👍🏼

alex-courtis · 2025-01-13T03:39:05Z

lua/nvim-tree/actions/node/utils.lua

+  -- check if buffer for file at cursor exists and if it is loaded
+  local bufnr_at_filename = vim.fn.bufnr(filename)
+  if bufnr_at_filename == -1 or vim.fn.getbufinfo(bufnr_at_filename)[1].loaded == 0 then
+    notify.error("No loaded buffer coincides with " .. notify_node)


Can we please change this to INFO? Users may wish to ignore this message.

Yeah, sure! Should I also change the error statement at line 37 (the one that says "Buffer for file " .. notify_node .. " is modified"), or just this one?

I think just this one. Deleting a modified buffer truly is an error.

alex-courtis · 2025-01-13T03:50:46Z

I like the modularity, it's really easy to read.

Having 3 new files is not necessary, delete and wipe can be handled in one place:
Create a single file buffer.lua: containing the utils function and fn( methods renamed to wipe and delete.
We don't really need the fn() pattern any more.

These actions do act on a node, and belong in actions/node. Rather than the absolute_path being passed in, the node itself should be passed in:

Prevents error when the user passes a node without that field.
Allows testing of the node's type as a FileNode. We don't want to try and delete directories or the tree node itself. That can silently exit.

GCrispino · 2025-01-15T01:46:31Z

I like the modularity, it's really easy to read.

Having 3 new files is not necessary, delete and wipe can be handled in one place: Create a single file buffer.lua: containing the utils function and fn( methods renamed to wipe and delete. We don't really need the fn() pattern any more.

These actions do act on a node, and belong in actions/node. Rather than the absolute_path being passed in, the node itself should be passed in:

Prevents error when the user passes a node without that field.

Allows testing of the node's type as a FileNode. We don't want to try and delete directories or the tree node itself. That can silently exit.

@alex-courtis

Ok, when I get some free time I'll work on these changes. Thanks for the review :)

GCrispino · 2025-01-18T02:57:00Z

@alex-courtis I've pushed some commits, and I believe I have addressed all of your issues :)

Kindly check when you can 🙏🏼 , thanks!

alex-courtis · 2025-01-23T22:32:02Z

Looks like we have some newly deprecated nvim methods : https://github.com/nvim-tree/nvim-tree.lua/actions/runs/12939265657/job/36091177064?pr=3040

I'll resolve them on master and merge.

alex-courtis

In the interests of speed, I pushed fixes for the review comments.

Please let me know if you'd prefer me not to push.

alex-courtis · 2025-01-23T22:24:08Z

lua/nvim-tree/actions/node/utils.lua

Looks like this file can go - everything is in buffer.lua

Oh yeah, we can remove this, I forgot to do so, sorry!

alex-courtis · 2025-01-23T22:26:35Z

lua/nvim-tree/actions/node/buffer.lua

+end
+
+function M.setup(_)
+end


We can remove this NOP; we're moving away from this setup pattern anyway.

alex-courtis · 2025-01-23T22:35:46Z

lua/nvim-tree/actions/node/buffer.lua

+---@param opts ApiNodeDeleteWipeBufferOpts|nil
+---@return nil
+function M.delete(node, opts)
+  M.delete_buffer("delete", node.absolute_path, opts)


This handles nil or partial node gracefully, however not a malformed node like { aaaabsolute_path = "foo" }

That's OK - garbage in, garbage out.

GCrispino · 2025-01-23T23:15:18Z

Looks like we have some newly deprecated nvim methods : https://github.com/nvim-tree/nvim-tree.lua/actions/runs/12939265657/job/36091177064?pr=3040

I'll resolve them on master and merge.

@alex-courtis all good for me 🫡 ! Thanks for jumping in and resolving these 🙏🏼

alex-courtis

Many thanks for the fantastic addition

GCrispino · 2025-01-25T02:01:36Z

Many thanks for the fantastic addition

Thanks for that, and for assisting here! Would love to contribute again if there are any good opportunities for newcomers

alex-courtis · 2025-01-25T02:38:37Z

Many thanks for the fantastic addition

Thanks for that, and for assisting here! Would love to contribute again if there are any good opportunities for newcomers

It's a pleasure to work with you and it'd be great to have another team member on board.

There's a PR Please label on many features / bugs - issues that we just don't have the bandwidth for.

Alternatively, there's a larger project for Multiple Instances under way. This task on the Project Board would be a good start - it's got a clear goal and definition of done.

alex-courtis · 2025-01-25T02:42:46Z

Added you as a project member so that you can push branches, review PRs, take tasks etc.

GCrispino · 2025-01-25T14:20:08Z

It's a pleasure to work with you and it'd be great to have another team member on board.

Thank you! Likewise, it was a pleasure to contribute :)

There's a PR Please label on many features / bugs - issues that we just don't have the bandwidth for.

Alternatively, there's a larger project for Multiple Instances under way. This task on the Project Board would be a good start - it's got a clear goal and definition of done.

Oh, nice! I think I'll pick up a bug so I get a bit more familiar with the project and Lua, as I'm not too familiar with the language and writing good code on it.
The Multiple Instances project sounds exciting!

GCrispino · 2025-01-25T14:20:30Z

Added you as a project member so that you can push branches, review PRs, take tasks etc.

Oh and of course, thanks for this! This is much appreciated :)

GCrispino added 5 commits December 27, 2024 23:39

feat(mappings): add key map to close file buffer

71451ea

feat: implement Api.node.buffer.delete

c72de8c

feat: implement Api.node.buffer.wipe

6de8526

refactor: add util fn for common delete ops on bufs

33ff62a

fix: minor fixes

e645b5f

GCrispino changed the title ~~WIP: feat(#2826): add node API methods for deleting/wiping buffers~~ WIP: feat(#3037): add node API methods for deleting/wiping buffers Dec 30, 2024

GCrispino mentioned this pull request Dec 30, 2024

Add keymap for closing buffer of file under cursor #3037

Closed

refactor: fix lint issues

404aae7

GCrispino changed the title ~~WIP: feat(#3037): add node API methods for deleting/wiping buffers~~ feat(#3037): add node API methods for deleting/wiping buffers Dec 31, 2024

alex-courtis requested changes Jan 13, 2025

View reviewed changes

fix: undo unintended ApiTreeToggleOpts change

2719542

GCrispino added 5 commits January 17, 2025 22:40

fix: change error message level to info

6e598f3

fix: remove unused opts

c87c193

refactor: merge delete-buffer and wipe-buffer into single buffer file

343b8a0

refactor: make wipe and delete fns take a node instead of a file path

199c0c0

docs: update help with new API commands

ede43ed

remove refactored utils.lua

0703c47

remove unused static setup

aa6fe10

alex-courtis approved these changes Jan 23, 2025

View reviewed changes

alex-courtis added 2 commits January 25, 2025 12:08

Merge branch 'master' into feat/close-file-buffer-2

2bcb5fe

tweak doc

7a1712e

alex-courtis approved these changes Jan 25, 2025

View reviewed changes

alex-courtis changed the title ~~feat(#3037): add node API methods for deleting/wiping buffers~~ feat(#3037): add API node.buffer.delete, node.buffer.wipe Jan 25, 2025

alex-courtis merged commit fee1da8 into nvim-tree:master Jan 25, 2025
6 checks passed

github-actions bot mentioned this pull request Jan 25, 2025

chore(master): release nvim-tree 1.11.0 #3051

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(#3037): add API node.buffer.delete, node.buffer.wipe #3040

feat(#3037): add API node.buffer.delete, node.buffer.wipe #3040

GCrispino commented Dec 30, 2024 •

edited by alex-courtis

Loading

alex-courtis left a comment •

edited

Loading

alex-courtis Jan 13, 2025

GCrispino Jan 15, 2025

alex-courtis Jan 13, 2025

alex-courtis Jan 13, 2025

GCrispino Jan 15, 2025

alex-courtis Jan 13, 2025

GCrispino Jan 15, 2025

alex-courtis Jan 13, 2025

GCrispino Jan 15, 2025

alex-courtis Jan 17, 2025

GCrispino Jan 18, 2025

alex-courtis commented Jan 13, 2025 •

edited

Loading

GCrispino commented Jan 15, 2025 •

edited

Loading

GCrispino commented Jan 18, 2025

alex-courtis commented Jan 23, 2025

alex-courtis left a comment

alex-courtis Jan 23, 2025

GCrispino Jan 23, 2025

alex-courtis Jan 23, 2025

alex-courtis Jan 23, 2025

GCrispino commented Jan 23, 2025

alex-courtis left a comment

GCrispino commented Jan 25, 2025

alex-courtis commented Jan 25, 2025

alex-courtis commented Jan 25, 2025

GCrispino commented Jan 25, 2025

GCrispino commented Jan 25, 2025

feat(#3037): add API node.buffer.delete, node.buffer.wipe #3040

feat(#3037): add API node.buffer.delete, node.buffer.wipe #3040

Conversation

GCrispino commented Dec 30, 2024 • edited by alex-courtis Loading

alex-courtis left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-courtis commented Jan 13, 2025 • edited Loading

GCrispino commented Jan 15, 2025 • edited Loading

GCrispino commented Jan 18, 2025

alex-courtis commented Jan 23, 2025

alex-courtis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GCrispino commented Jan 23, 2025

alex-courtis left a comment

Choose a reason for hiding this comment

GCrispino commented Jan 25, 2025

alex-courtis commented Jan 25, 2025

alex-courtis commented Jan 25, 2025

GCrispino commented Jan 25, 2025

GCrispino commented Jan 25, 2025

GCrispino commented Dec 30, 2024 •

edited by alex-courtis

Loading

alex-courtis left a comment •

edited

Loading

alex-courtis commented Jan 13, 2025 •

edited

Loading

GCrispino commented Jan 15, 2025 •

edited

Loading